package com.example.user.config;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.cloud.sleuth.instrument.async.LazyTraceExecutor;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.AsyncConfigurerSupport;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import java.util.concurrent.Executor;

/**
 * @Author 刘武贵
 * @Date 2024-03-10 12:19
 * @Description 功能描述：Sleuth异步线程池配置 用来自定义异步任务线程池
 */
@Configuration
/**
 * 启用Spring Boot的自动配置
 */
@EnableAutoConfiguration
/**
 * ThreadPoolTaskExecutorConfig 类继承自 AsyncConfigurerSupport，用于配置线程池任务执行器。
 */
public class ThreadPoolTaskExecutorConfig extends AsyncConfigurerSupport {

    /**
     * 自动注入BeanFactory，用于在LazyTraceExecutor中使用
     */
    @Autowired
    private BeanFactory beanFactory;

    /**
     * 提供一个异步执行器的配置方法。
     * 访问链接：http://localhost:10001/server-user/user/async/api
     *
     * @return 返回一个Executor实例，用于异步任务的执行。
     */
    @Override
    public Executor getAsyncExecutor() {
        /**
         * 创建一个线程池任务执行器实例。
         * <p>此代码段初始化了一个 ThreadPoolTaskExecutor 的实例，该实例可用于提交任务到线程池进行异步执行。
         * ThreadPoolTaskExecutor 是 Spring 提供的一个线程池实现，允许配置各种线程池特性和行为。
         *
         * @return ThreadPoolTaskExecutor 返回创建的线程池任务执行器实例。
         */
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // 设置核心线程池大小为2
        executor.setCorePoolSize(2);
        // 设置最大线程池大小为5
        executor.setMaxPoolSize(5);
        // 设置队列容量为10
        executor.setQueueCapacity(10);
        // 设置线程前缀名为"trace-thread-"
        executor.setThreadNamePrefix("trace-thread-");
        // 初始化线程池
        executor.initialize();
        // 原计划直接返回配置好的ThreadPoolTaskExecutor实例
//        return executor;

        /**
         * Sleuth支持对异步任务的链路追踪，在项目中使用@Async注解开启一个异步任务后，
         * Sleuth会为异步任务重新生成一个Span。但是如果使用了自定义的异步任务线程池，则会导致Sleuth无法新创建一个Span，
         * 而是会重新生成Trace和Span。此时，需要使用Sleuth提供的LazyTraceExecutor类来包装下异步任务线程池，才能在异步任务调用链路中重新创建Span。
         */
        // 演示包装自定义线程池
        // 实际返回的是一个包装了BeanFactory和ThreadPoolTaskExecutor的LazyTraceExecutor实例
        // 这样做提供了更灵活的异步任务执行控制和扩展
        return new LazyTraceExecutor(this.beanFactory, executor);
    }
}
